/*
 * Copyright 2017 - 2024 the original author or authors.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see [https://www.gnu.org/licenses/]
 */

package infra.core.test.tools;

import java.io.IOException;

/**
 * Callback interface used to write file content. Designed to align with
 * JavaPoet's {@code JavaFile.writeTo} method.
 *
 * @author Phillip Webb
 * @since 4.0
 */
@FunctionalInterface
public interface WritableContent {

  /**
   * Callback method that should write the content to the given
   * {@link Appendable}.
   *
   * @param out the {@link Appendable} used to receive the content
   * @throws IOException on IO error
   */
  void writeTo(Appendable out) throws IOException;

}
